api: blocks/{round}/logs endpoint #5865

joe-p · 2023-12-11T18:07:59Z

Summary

This is a new endpoint to get all of the logs from all appcalls in a given block. This endpoint was created specifically due to the encoding issue with the current /blocks/{round} endpoint (#5807).

Test Plan

Tests cover the following scenarios:

log in outer transaction
log from inner transaction
log from newly created application
logs from multiple outer app calls

daemon/algod/api/server/v2/handlers.go

codecov · 2023-12-11T18:31:47Z

Codecov Report

Attention: Patch coverage is 0% with 40 lines in your changes are missing coverage. Please review.

Project coverage is 56.17%. Comparing base (5f81b7b) to head (267de9e).
Report is 1 commits behind head on master.

Files	Patch %	Lines
daemon/algod/api/server/v2/handlers.go	0.00%	35 Missing ⚠️
libgoal/libgoal.go	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5865      +/-   ##
==========================================
+ Coverage   52.42%   56.17%   +3.75%     
==========================================
  Files         482      482              
  Lines       67969    68009      +40     
==========================================
+ Hits        35630    38205    +2575     
+ Misses      29656    27210    -2446     
+ Partials     2683     2594      -89

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

daemon/algod/api/algod.oas2.json

daemon/algod/api/server/v2/handlers.go

joe-p · 2023-12-11T23:38:14Z

I've verified the logs are returned properly via external testing here: https://github.com/joe-p/block-log-debug/blob/6daea7ad53b83366c75aaf3325c719bc6fbd0646/__test__/block-log-debug.test.ts#L12

I'll need to write the proper tests here but should be good to go.

Other things to consider:

Do we want query parameters to filter logs? I can imagine a prefix and appID filter would be useful.
I feel like we should probably have some sort of way to limit response size. I think the most reasonable approach is to add query parameters for start and maxResults parameter but this will only work if txn order is deterministic in the block. I would think it is but would like some confirmation.

jannotti · 2023-12-12T00:03:17Z

Since this returns, at most, the logs in one block, I don't think you need to add any filtering or limiting.

joe-p · 2023-12-12T00:05:41Z

Yeah true, we know the upper bound due to the block size limit. Keeping it as is is good with me then.

daemon/algod/api/algod.oas2.json

jannotti

A few small things you may or may not bother with.

daemon/algod/api/algod.oas2.json

daemon/algod/api/server/v2/handlers.go

Co-authored-by: John Jannotti <jannotti@gmail.com>

joe-p · 2024-01-19T21:41:26Z

@jasonpaulos @jannotti I just added a fairly basic test in test/e2e-go/restAPI/other/appsRestAPI_test.go. Seemed like the most appropriate place for this to go but let me know what else is needed before this can be merged.

test/e2e-go/restAPI/other/appsRestAPI_test.go

daemon/algod/api/server/v2/handlers.go

Co-authored-by: Jason Paulos <jasonpaulos@users.noreply.github.com>

daemon/algod/api/algod.oas2.json

daemon/algod/api/server/v2/handlers.go

test/e2e-go/restAPI/other/appsRestAPI_test.go

Co-authored-by: John Jannotti <jannotti@gmail.com>

jannotti

I'm happy if we get some form of the description change I recommended. I want the response order to be defined.

daemon/algod/api/algod.oas2.json

jasonpaulos

+1 to being more explicit about the endpoint description, but other than that, this looks good

Co-authored-by: John Jannotti <john.jannotti@algorand.com>

gmalouf · 2024-05-14T14:19:40Z

closes #5807

jannotti reviewed Dec 11, 2023

View reviewed changes

daemon/algod/api/server/v2/handlers.go Outdated Show resolved Hide resolved

daemon/algod/api/server/v2/handlers.go Outdated Show resolved Hide resolved

daemon/algod/api/server/v2/handlers.go Outdated Show resolved Hide resolved

jannotti reviewed Dec 11, 2023

View reviewed changes

daemon/algod/api/algod.oas2.json Outdated Show resolved Hide resolved

jasonpaulos reviewed Dec 11, 2023

View reviewed changes

daemon/algod/api/server/v2/handlers.go Outdated Show resolved Hide resolved

jannotti reviewed Dec 12, 2023

View reviewed changes

daemon/algod/api/algod.oas2.json Outdated Show resolved Hide resolved

jannotti reviewed Dec 12, 2023

View reviewed changes

daemon/algod/api/algod.oas2.json Outdated Show resolved Hide resolved

daemon/algod/api/server/v2/handlers.go Outdated Show resolved Hide resolved

daemon/algod/api/server/v2/handlers.go Outdated Show resolved Hide resolved

joe-p and others added 14 commits January 19, 2024 16:37

GetBlockLogs

0a2c6c9

fix duplicate semaphore import

fab4471

add oapi path

efbcbb8

use sized slice for byte logs

133934a

Co-authored-by: John Jannotti <jannotti@gmail.com>

NewBlockLog

9de4a6b

remove array references

ec9c4b8

check length of logs before NewBlockLog

c719af7

getAppIndexFromTxn

23a3257

add tests

1d6c94c

fix typo

916cf79

Co-authored-by: John Jannotti <jannotti@gmail.com>

use convertSlice

6a41466

Co-authored-by: John Jannotti <jannotti@gmail.com>

fix convertSlice

bc94490

return BlockLog value from NewBlockLog

4909d96

BlockLog -> AppCallLogs

8c3ae7e

joe-p force-pushed the feat/blocks_log_endpoint branch from 5971300 to 8c3ae7e Compare January 19, 2024 21:38

joe-p marked this pull request as ready for review January 19, 2024 21:40

jasonpaulos added the Enhancement label Jan 22, 2024

jasonpaulos reviewed Jan 25, 2024

View reviewed changes

joe-p added 2 commits January 31, 2024 20:58

test with inner txn log

2e47646

add missing assignment, calc txid once

6363c29

joe-p and others added 2 commits February 23, 2024 14:17

assert equality for fully formed response struct

0526996

Co-authored-by: Jason Paulos <jasonpaulos@users.noreply.github.com>

fix asserts

b3add97

jasonpaulos previously approved these changes Mar 5, 2024

View reviewed changes

jasonpaulos requested a review from jannotti March 7, 2024 21:16

jannotti reviewed Mar 8, 2024

View reviewed changes

use append name/arg order

a504839

joe-p dismissed jasonpaulos’s stale review via a504839 April 25, 2024 19:24

joe-p and others added 6 commits April 25, 2024 15:25

update comment

72aedc5

Co-authored-by: John Jannotti <jannotti@gmail.com>

txid -> txId

94fc1f0

single call to appendLogsFromTxns for each outer txn

6209b64

don't append inners to outer in appendLogsFromTxns call

9366062

more test scenarios

733567f

update descriptions

340ad0a

joe-p closed this Apr 26, 2024

joe-p reopened this Apr 26, 2024

Merge branch 'master' into feat/blocks_log_endpoint

ac5748c

jannotti previously approved these changes Apr 29, 2024

View reviewed changes

daemon/algod/api/algod.oas2.json Outdated Show resolved Hide resolved

jasonpaulos reviewed Apr 29, 2024

View reviewed changes

update descriptions to specify order

267de9e

Co-authored-by: John Jannotti <john.jannotti@algorand.com>

joe-p dismissed jannotti’s stale review via 267de9e April 30, 2024 11:46

jasonpaulos approved these changes Apr 30, 2024

View reviewed changes

jasonpaulos requested a review from jannotti April 30, 2024 14:13

jannotti approved these changes Apr 30, 2024

View reviewed changes

jasonpaulos merged commit 13c50af into algorand:master Apr 30, 2024
18 checks passed

joe-p deleted the feat/blocks_log_endpoint branch April 30, 2024 16:00

This was referenced May 10, 2024

go-algorand 3.24.0-beta Release PR #5997

Merged

go-algorand 3.24.0-stable Release PR #6000

Merged

gmalouf mentioned this pull request May 14, 2024

/blocks/{round} endpoint returning malformed logs (non-ASCII data only) #5807

Closed

gmalouf linked an issue May 14, 2024 that may be closed by this pull request

/blocks/{round} endpoint returning malformed logs (non-ASCII data only) #5807

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api: blocks/{round}/logs endpoint #5865

api: blocks/{round}/logs endpoint #5865

joe-p commented Dec 11, 2023 •

edited

Loading

codecov bot commented Dec 11, 2023 •

edited

Loading

joe-p commented Dec 11, 2023 •

edited

Loading

jannotti commented Dec 12, 2023

joe-p commented Dec 12, 2023

jannotti left a comment

joe-p commented Jan 19, 2024

jannotti left a comment

jasonpaulos left a comment

gmalouf commented May 14, 2024

api: blocks/{round}/logs endpoint #5865

api: blocks/{round}/logs endpoint #5865

Conversation

joe-p commented Dec 11, 2023 • edited Loading

Summary

Test Plan

codecov bot commented Dec 11, 2023 • edited Loading

Codecov Report

joe-p commented Dec 11, 2023 • edited Loading

jannotti commented Dec 12, 2023

joe-p commented Dec 12, 2023

jannotti left a comment

Choose a reason for hiding this comment

joe-p commented Jan 19, 2024

jannotti left a comment

Choose a reason for hiding this comment

jasonpaulos left a comment

Choose a reason for hiding this comment

gmalouf commented May 14, 2024

joe-p commented Dec 11, 2023 •

edited

Loading

codecov bot commented Dec 11, 2023 •

edited

Loading

joe-p commented Dec 11, 2023 •

edited

Loading